Generate enterprise upgrade URL

POST

https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/upgrade-url

curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/upgrade-url" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "adminEmail": "[email protected]",
  "allowedDomains": [
    "string"
  ]
}'

const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/upgrade-url", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "adminEmail": "[email protected]",
    "allowedDomains": [
      "string"
    ]
  }),
});

const data = await response.json();

import requests

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/upgrade-url",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "adminEmail": "[email protected]",
      "allowedDomains": [
        "string"
      ]
    },
)

data = response.json()

Request

Send your API key in the request header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Unique identifier for organization managing Apple enterprise application deployments and configurations.

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json

adminEmail string optional

Optional work email hint prefilled on Google upgrade flow. Must belong to allowedDomains when that list is non-empty.

≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email

allowedDomains array [string] optional

Optional list of permitted domains for the admin email during upgrade, as defined by the Android Management API.

{
    "adminEmail": "[email protected]",
    "allowedDomains": [
        "string"
    ]
}

Responses

200 Response application/json

status boolean required

data object required

url string required

Google-generated URL that the IT admin must open to complete upgrade to a managed Google domain. Cannot be embedded in an iframe.

{
    "status": true,
    "data": {
        "url": "string"
    }
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5095

message string optional

Error From Emm Android Library

{
    "status": false,
    "error": {
        "code": 5050,
        "message": "Feature not allowed for you billing plan"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}

Request

Authorization

Path Params1

Request Body

Responses